<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RichWebPageEvent | Raxan User Guide</title>
    <link href="../raxan/styles/master.css" rel="stylesheet" type="text/css" />
    <!--[if IE]><link rel="stylesheet" href="../raxan/styles/master.ie.css" type="text/css"><![endif]-->
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        hljs.initHighlightingOnLoad('javascript','html','php');
    </script>

</head>

<body>
    <div class="container c48 prepend-top">
        <h2 class="bottom">Raxan User Guide</h2>
        <div class="navbar">
            <div class="lf"><div class="rt"><div class="md">
                <ul>
                    <li><a href="../index.html" title="The Rich Ajax, CSS &amp; PHP Framework" >Home</a></li>
                    <li><a href="table-of-contents.html" title="Blog Posts" >Table Of Contents</a></li>
                </ul>
            </div></div></div>
        </div>
        <div class="prepend1 append1"><div class="container c45">
    <h2 class="class-name">Class RichWebPageEvent</h2>

    <a name="sec-description"></a>
    <div class="box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
            <span class="disabled">Description</span> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                        |                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="info-box-body">
            <!-- ========== Info from phpDoc block ========= -->
            <p class="short-description">Used internally by RichWebPage</p>
            <p class="notes">
            Located in <a class="field" href="#">/shared/rich.webpage.php</a> (line <span class="field">1130</span>)
            </p>


            <pre></pre>

        </div>
    </div>



    <a name="sec-var-summary"></a>
    <div class="box bmm">
        <div class="box-title">Variable Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
                            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="info-box-body">
            <div class="var-summary">
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$button" title="details" class="var-name">$button</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$ctrlKey" title="details" class="var-name">$ctrlKey</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$data" title="details" class="var-name">$data</a>
                </div>
                <div class="var-title">
                    <span class="var-type">$target</span>
                    <a href="#$iPage" title="details" class="var-name">$iPage</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$isStopPropagation" title="details" class="var-name">$isStopPropagation</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$metaKey" title="details" class="var-name">$metaKey</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$pageX" title="details" class="var-name">$pageX</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$pageY" title="details" class="var-name">$pageY</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$result" title="details" class="var-name">$result</a>
                </div>
                <div class="var-title">
                    <span class="var-type">$target</span>
                    <a href="#$target" title="details" class="var-name">$target</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$targetX" title="details" class="var-name">$targetX</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$targetY" title="details" class="var-name">$targetY</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$type" title="details" class="var-name">$type</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$uiDraggable" title="details" class="var-name">$uiDraggable</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$uiHelper" title="details" class="var-name">$uiHelper</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$uiSender" title="details" class="var-name">$uiSender</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$value" title="details" class="var-name">$value</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$which" title="details" class="var-name">$which</a>
                </div>
            </div>
        </div>
    </div>

    <a name="sec-method-summary"></a>
    <div class="box bmm">
        <div class="box-title">Method Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

                |
            <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
        </div>
        <div class="info-box-body">
            <div class="method-summary">

                <div class="method-definition">
                    <span class="method-result">RichWebPageEvent</span>
                    <a href="#__construct" title="details" class="method-name">__construct</a>
                                            (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$page</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$e</span> = <span class="var-default">null</span>])
                </div>

                <div class="method-definition">
                    <span class="method-result"><a href="RichClientExtension.html">RichClientExtension</a></span>
                    <a href="#client" title="details" class="method-name">client</a>
                                            ([<span class="var-type"></span>&nbsp;<span class="var-name">$selector</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$context</span> = <span class="var-default">null</span>])
                </div>

                <div class="method-definition">
                    <span class="method-result"><a href="RichWebPage.html">RichWebPage</a></span>
                    <a href="#page" title="details" class="method-name">page</a>
                                            ([<span class="var-type"></span>&nbsp;<span class="var-name">$css</span> = <span class="var-default">null</span>])
                </div>

                <div class="method-definition">
                    <span class="method-result">RichEvent</span>
                    <a href="#stopPropagation" title="details" class="method-name">stopPropagation</a>
                                        ()
                </div>
            </div>
        </div>
    </div>

    <a name="sec-vars"></a>
    <div class="box bmm">
        <div class="box-title">Variables</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)


                                        |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="info-box-body">
            <a name="var$button" id="$button"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$button</span>
                        (line <span class="line-number">1139</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$ctrlKey" id="$ctrlKey"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$ctrlKey</span>
                        (line <span class="line-number">1142</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$data" id="$data"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$data</span>
                        (line <span class="line-number">1139</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$iPage" id="$iPage"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">$target</span>
                        <span class="var-name">$iPage</span>
                        (line <span class="line-number">1147</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">var:</span> RichWebPage</li>
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$isStopPropagation" id="$isStopPropagation"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$isStopPropagation</span>
             = <span class="var-default"> false</span>          (line <span class="line-number">1143</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$metaKey" id="$metaKey"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$metaKey</span>
                        (line <span class="line-number">1142</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$pageX" id="$pageX"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$pageX</span>
                        (line <span class="line-number">1140</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$pageY" id="$pageY"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$pageY</span>
                        (line <span class="line-number">1140</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$result" id="$result"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$result</span>
             = <span class="var-default"> null</span>           (line <span class="line-number">1138</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$target" id="$target"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">$target</span>
                        <span class="var-name">$target</span>
                        (line <span class="line-number">1134</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">var:</span> DOMElement</li>
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$targetX" id="$targetX"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$targetX</span>
                        (line <span class="line-number">1141</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$targetY" id="$targetY"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$targetY</span>
                        (line <span class="line-number">1141</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$type" id="$type"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$type</span>
                        (line <span class="line-number">1137</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$uiDraggable" id="$uiDraggable"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$uiDraggable</span>
                        (line <span class="line-number">1135</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$uiHelper" id="$uiHelper"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$uiHelper</span>
                        (line <span class="line-number">1135</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$uiSender" id="$uiSender"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$uiSender</span>
                        (line <span class="line-number">1135</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$value" id="$value"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$value</span>
                        (line <span class="line-number">1139</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$which" id="$which"><!-- --></A>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$which</span>
                        (line <span class="line-number">1142</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>

        </div>
    </div>

    <a name="sec-methods"></a>
    <div class="box bmm">
        <div class="box-title">Methods</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

        </div>
        <div class="info-box-body">
            <A NAME='method_detail'></A>
            <a name="method__construct" id="__construct"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">Constructor __construct</span> (line <span class="line-number">1149</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">RichWebPageEvent</span>
                    <span class="method-name">
            __construct
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$page</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$e</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$type</span>         </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">&$page</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$e</span>            </li>
                </ul>


            </div>
            <a name="methodclient" id="client"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">client</span> (line <span class="line-number">1164</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns an instance of the RichClientExtension class</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result"><a href="RichClientExtension.html">RichClientExtension</a></span>
                    <span class="method-name">
            client
                    </span>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$selector</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$context</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$selector</span>         </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$context</span>          </li>
                </ul>


            </div>
            <a name="methodpage" id="page"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">page</span> (line <span class="line-number">1173</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns an instance of the rich web page controller that's associated with this event</p>

                <div class="method-signature">
                    <span class="method-result"><a href="RichWebPage.html">RichWebPage</a></span>
                    <span class="method-name">
            page
                    </span>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$css</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$css</span>          </li>
                </ul>


            </div>
            <a name="methodstopPropagation" id="stopPropagation"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">stopPropagation</span> (line <span class="line-number">1182</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Stops event propagation</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">RichEvent</span>
                    <span class="method-name">
            stopPropagation
                    </span>
                ()
                </div>



            </div>

        </div>
    </div>


    <p class="notes" id="credit">
        Documentation generated on Tue, 18 Aug 2009 01:39:56 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
    </p>
</div>
</div>
        <div class="tpb pad" style="text-align:right">
            <a href="table-of-contents.html" class="quiet">Back to Table of Content</a>
        </div>
    </div>
</body>

</html>

